Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardize documentation for ReadtheDocs #524

Merged
merged 2 commits into from
Jan 3, 2024
Merged

Standardize documentation for ReadtheDocs #524

merged 2 commits into from
Jan 3, 2024

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Dec 28, 2023

Apply the following changes to project documentation for ReadtheDocs:

  • add version number to documentation left navigation bar and page title
  • add an "About" section with a license page
  • enable htmlzip, pdf, epub formats when publishing on Read the Docs
  • set pdf title, author, copyright, and version
  • rename .sphinx/.doxygen to sphinx/doxygen
  • remove docBin from URL
  • update rocm-docs-core dependency
  • update dependabot config

Relates to ROCm/rocm-docs-core#330

Also apply doc fixes

@samjwu samjwu added documentation Improvements or additions to documentation ci:docs-only Only run Read the Docs CI on this PR labels Dec 28, 2023
@samjwu samjwu self-assigned this Dec 28, 2023
jichangjichang
jichangjichang approved these changes Jan 2, 2024
View reviewed changes
Copy link
Collaborator

@jichangjichang jichangjichang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@KKyang KKyang merged commit dff95b5 into ROCm:develop Jan 3, 2024
4 checks passed
@samjwu samjwu deleted the rtd branch January 3, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KKyang KKyang KKyang approved these changes

@jichangjichang jichangjichang jichangjichang approved these changes

@aazz44ss aazz44ss Awaiting requested review from aazz44ss aazz44ss is a code owner

@vin-huang vin-huang Awaiting requested review from vin-huang vin-huang is a code owner

@imcarsonliao imcarsonliao Awaiting requested review from imcarsonliao imcarsonliao is a code owner

Assignees

@samjwu samjwu

Labels
ci:docs-only Only run Read the Docs CI on this PR documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@samjwu @KKyang @jichangjichang